[api-documenter] New api-documenter.json for customizing/eliminating generated strings #5178
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ious output notices, as well as disabling the "breadcrumb" generation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…ious output notices, as well as disabling the "breadcrumb" generation
Summary
This is currently a DRAFT pull request. I'm proposing some new api-documenter.json settings to address two feature requests:
Remove the navigation "breadcrumb" links from the generated .md files:
[api-documenter] Add a setting to remove breadcrumbs from the generated markdown #5177
Remove the
Do not edit this filenotice from the generated .md files:[api-documenter] Add a setting to remove the "do not edit" comment from the generated markdown #5176
I went a step further and designed an option for configuring the text of various notices. To eliminate a notice entirely, you would set its text to be an empty string (
"").Details
There is currently some confusion where
api-documenter markdowndoes not read api-documenter.json, whereasapi-documenter generatedoes use this config file. We had some plans to clarify that, but I've forgotten the details. Need to investigate before proceeding.How it was tested
Impacted documentation